Other Functions

MGLAltitudeForZoomLevel

The following functions are available globally.

  • MGLMapPointMake

    Creates a new MGLMapPoint from the given X and Y coordinates, and zoom level.

    Declaration

    Objective-C

    static inline MGLMapPoint MGLMapPointMake(CGFloat x, CGFloat y,
                                                        CGFloat zoomLevel)

    Swift

    func MGLMapPointMake(_ x: CGFloat, _ y: CGFloat, _ zoomLevel: CGFloat) -> MGLMapPoint
  • MGLMapPointForCoordinate

    Returns Mercator projection of a WGS84 coordinate at the specified zoom level.

    Declaration

    Objective-C

    extern MGLMapPoint MGLMapPointForCoordinate(CLLocationCoordinate2D coordinate,
                                                          double zoomLevel)

    Swift

    func MGLMapPointForCoordinate(_ coordinate: CLLocationCoordinate2D, _ zoomLevel: Double) -> MGLMapPoint
  • Converts a map zoom level to a camera altitude.

    Declaration

    Objective-C

    extern CLLocationDistance MGLAltitudeForZoomLevel(double zoomLevel,
                                                                CGFloat pitch,
                                                                CLLocationDegrees latitude,
                                                                CGSize size)

    Swift

    func MGLAltitudeForZoomLevel(_ zoomLevel: Double, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> CLLocationDistance

    Parameters

    zoomLevel

    The zoom level to convert.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    An altitude measured in meters.

  • MGLZoomLevelForAltitude

    Converts a camera altitude to a map zoom level.

    Declaration

    Objective-C

    extern double MGLZoomLevelForAltitude(CLLocationDistance altitude,
                                                    CGFloat pitch, CLLocationDegrees latitude,
                                                    CGSize size)

    Swift

    func MGLZoomLevelForAltitude(_ altitude: CLLocationDistance, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> Double

    Parameters

    altitude

    The altitude to convert, measured in meters.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    A zero-based zoom level.

  • MGLSphericalPositionMake

    Creates a new MGLSphericalPosition from the given radial, azimuthal, polar.

    Declaration

    Objective-C

    static inline MGLSphericalPosition
              MGLSphericalPositionMake(CGFloat radial, CLLocationDirection azimuthal,
                                       CLLocationDirection polar)

    Swift

    func MGLSphericalPositionMake(_ radial: CGFloat, _ azimuthal: CLLocationDirection, _ polar: CLLocationDirection) -> MGLSphericalPosition

    Parameters

    radial

    The radial coordinate.

    azimuthal

    The azimuthal angle.

    polar

    The polar angle.

    Return Value

    Returns a MGLSphericalPosition struct containing the position attributes.

  • MGLTransitionMake

    Creates a new MGLTransition from the given duration and delay.

    Declaration

    Objective-C

    static inline MGLTransition MGLTransitionMake(NSTimeInterval duration,
                                                            NSTimeInterval delay)

    Swift

    func MGLTransitionMake(_ duration: TimeInterval, _ delay: TimeInterval) -> MGLTransition

    Parameters

    duration

    The amount of time the animation should take, not including the delay.

    delay

    The amount of time in seconds to wait before beginning the animation.

    Return Value

    Returns a MGLTransition struct containing the transition attributes.

MGLMapPointForCoordinate

The following functions are available globally.

  • MGLMapPointMake

    Creates a new MGLMapPoint from the given X and Y coordinates, and zoom level.

    Declaration

    Objective-C

    static inline MGLMapPoint MGLMapPointMake(CGFloat x, CGFloat y,
                                                        CGFloat zoomLevel)

    Swift

    func MGLMapPointMake(_ x: CGFloat, _ y: CGFloat, _ zoomLevel: CGFloat) -> MGLMapPoint
  • MGLMapPointForCoordinate

    Returns Mercator projection of a WGS84 coordinate at the specified zoom level.

    Declaration

    Objective-C

    extern MGLMapPoint MGLMapPointForCoordinate(CLLocationCoordinate2D coordinate,
                                                          double zoomLevel)

    Swift

    func MGLMapPointForCoordinate(_ coordinate: CLLocationCoordinate2D, _ zoomLevel: Double) -> MGLMapPoint
  • Converts a map zoom level to a camera altitude.

    Declaration

    Objective-C

    extern CLLocationDistance MGLAltitudeForZoomLevel(double zoomLevel,
                                                                CGFloat pitch,
                                                                CLLocationDegrees latitude,
                                                                CGSize size)

    Swift

    func MGLAltitudeForZoomLevel(_ zoomLevel: Double, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> CLLocationDistance

    Parameters

    zoomLevel

    The zoom level to convert.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    An altitude measured in meters.

  • MGLZoomLevelForAltitude

    Converts a camera altitude to a map zoom level.

    Declaration

    Objective-C

    extern double MGLZoomLevelForAltitude(CLLocationDistance altitude,
                                                    CGFloat pitch, CLLocationDegrees latitude,
                                                    CGSize size)

    Swift

    func MGLZoomLevelForAltitude(_ altitude: CLLocationDistance, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> Double

    Parameters

    altitude

    The altitude to convert, measured in meters.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    A zero-based zoom level.

  • MGLSphericalPositionMake

    Creates a new MGLSphericalPosition from the given radial, azimuthal, polar.

    Declaration

    Objective-C

    static inline MGLSphericalPosition
              MGLSphericalPositionMake(CGFloat radial, CLLocationDirection azimuthal,
                                       CLLocationDirection polar)

    Swift

    func MGLSphericalPositionMake(_ radial: CGFloat, _ azimuthal: CLLocationDirection, _ polar: CLLocationDirection) -> MGLSphericalPosition

    Parameters

    radial

    The radial coordinate.

    azimuthal

    The azimuthal angle.

    polar

    The polar angle.

    Return Value

    Returns a MGLSphericalPosition struct containing the position attributes.

  • MGLTransitionMake

    Creates a new MGLTransition from the given duration and delay.

    Declaration

    Objective-C

    static inline MGLTransition MGLTransitionMake(NSTimeInterval duration,
                                                            NSTimeInterval delay)

    Swift

    func MGLTransitionMake(_ duration: TimeInterval, _ delay: TimeInterval) -> MGLTransition

    Parameters

    duration

    The amount of time the animation should take, not including the delay.

    delay

    The amount of time in seconds to wait before beginning the animation.

    Return Value

    Returns a MGLTransition struct containing the transition attributes.

MGLMapPointMake

The following functions are available globally.

  • MGLMapPointMake

    Creates a new MGLMapPoint from the given X and Y coordinates, and zoom level.

    Declaration

    Objective-C

    static inline MGLMapPoint MGLMapPointMake(CGFloat x, CGFloat y,
                                                        CGFloat zoomLevel)

    Swift

    func MGLMapPointMake(_ x: CGFloat, _ y: CGFloat, _ zoomLevel: CGFloat) -> MGLMapPoint
  • MGLMapPointForCoordinate

    Returns Mercator projection of a WGS84 coordinate at the specified zoom level.

    Declaration

    Objective-C

    extern MGLMapPoint MGLMapPointForCoordinate(CLLocationCoordinate2D coordinate,
                                                          double zoomLevel)

    Swift

    func MGLMapPointForCoordinate(_ coordinate: CLLocationCoordinate2D, _ zoomLevel: Double) -> MGLMapPoint
  • Converts a map zoom level to a camera altitude.

    Declaration

    Objective-C

    extern CLLocationDistance MGLAltitudeForZoomLevel(double zoomLevel,
                                                                CGFloat pitch,
                                                                CLLocationDegrees latitude,
                                                                CGSize size)

    Swift

    func MGLAltitudeForZoomLevel(_ zoomLevel: Double, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> CLLocationDistance

    Parameters

    zoomLevel

    The zoom level to convert.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    An altitude measured in meters.

  • MGLZoomLevelForAltitude

    Converts a camera altitude to a map zoom level.

    Declaration

    Objective-C

    extern double MGLZoomLevelForAltitude(CLLocationDistance altitude,
                                                    CGFloat pitch, CLLocationDegrees latitude,
                                                    CGSize size)

    Swift

    func MGLZoomLevelForAltitude(_ altitude: CLLocationDistance, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> Double

    Parameters

    altitude

    The altitude to convert, measured in meters.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    A zero-based zoom level.

  • MGLSphericalPositionMake

    Creates a new MGLSphericalPosition from the given radial, azimuthal, polar.

    Declaration

    Objective-C

    static inline MGLSphericalPosition
              MGLSphericalPositionMake(CGFloat radial, CLLocationDirection azimuthal,
                                       CLLocationDirection polar)

    Swift

    func MGLSphericalPositionMake(_ radial: CGFloat, _ azimuthal: CLLocationDirection, _ polar: CLLocationDirection) -> MGLSphericalPosition

    Parameters

    radial

    The radial coordinate.

    azimuthal

    The azimuthal angle.

    polar

    The polar angle.

    Return Value

    Returns a MGLSphericalPosition struct containing the position attributes.

  • MGLTransitionMake

    Creates a new MGLTransition from the given duration and delay.

    Declaration

    Objective-C

    static inline MGLTransition MGLTransitionMake(NSTimeInterval duration,
                                                            NSTimeInterval delay)

    Swift

    func MGLTransitionMake(_ duration: TimeInterval, _ delay: TimeInterval) -> MGLTransition

    Parameters

    duration

    The amount of time the animation should take, not including the delay.

    delay

    The amount of time in seconds to wait before beginning the animation.

    Return Value

    Returns a MGLTransition struct containing the transition attributes.

MGLSphericalPositionMake

The following functions are available globally.

  • MGLMapPointMake

    Creates a new MGLMapPoint from the given X and Y coordinates, and zoom level.

    Declaration

    Objective-C

    static inline MGLMapPoint MGLMapPointMake(CGFloat x, CGFloat y,
                                                        CGFloat zoomLevel)

    Swift

    func MGLMapPointMake(_ x: CGFloat, _ y: CGFloat, _ zoomLevel: CGFloat) -> MGLMapPoint
  • MGLMapPointForCoordinate

    Returns Mercator projection of a WGS84 coordinate at the specified zoom level.

    Declaration

    Objective-C

    extern MGLMapPoint MGLMapPointForCoordinate(CLLocationCoordinate2D coordinate,
                                                          double zoomLevel)

    Swift

    func MGLMapPointForCoordinate(_ coordinate: CLLocationCoordinate2D, _ zoomLevel: Double) -> MGLMapPoint
  • Converts a map zoom level to a camera altitude.

    Declaration

    Objective-C

    extern CLLocationDistance MGLAltitudeForZoomLevel(double zoomLevel,
                                                                CGFloat pitch,
                                                                CLLocationDegrees latitude,
                                                                CGSize size)

    Swift

    func MGLAltitudeForZoomLevel(_ zoomLevel: Double, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> CLLocationDistance

    Parameters

    zoomLevel

    The zoom level to convert.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    An altitude measured in meters.

  • MGLZoomLevelForAltitude

    Converts a camera altitude to a map zoom level.

    Declaration

    Objective-C

    extern double MGLZoomLevelForAltitude(CLLocationDistance altitude,
                                                    CGFloat pitch, CLLocationDegrees latitude,
                                                    CGSize size)

    Swift

    func MGLZoomLevelForAltitude(_ altitude: CLLocationDistance, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> Double

    Parameters

    altitude

    The altitude to convert, measured in meters.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    A zero-based zoom level.

  • MGLSphericalPositionMake

    Creates a new MGLSphericalPosition from the given radial, azimuthal, polar.

    Declaration

    Objective-C

    static inline MGLSphericalPosition
              MGLSphericalPositionMake(CGFloat radial, CLLocationDirection azimuthal,
                                       CLLocationDirection polar)

    Swift

    func MGLSphericalPositionMake(_ radial: CGFloat, _ azimuthal: CLLocationDirection, _ polar: CLLocationDirection) -> MGLSphericalPosition

    Parameters

    radial

    The radial coordinate.

    azimuthal

    The azimuthal angle.

    polar

    The polar angle.

    Return Value

    Returns a MGLSphericalPosition struct containing the position attributes.

  • MGLTransitionMake

    Creates a new MGLTransition from the given duration and delay.

    Declaration

    Objective-C

    static inline MGLTransition MGLTransitionMake(NSTimeInterval duration,
                                                            NSTimeInterval delay)

    Swift

    func MGLTransitionMake(_ duration: TimeInterval, _ delay: TimeInterval) -> MGLTransition

    Parameters

    duration

    The amount of time the animation should take, not including the delay.

    delay

    The amount of time in seconds to wait before beginning the animation.

    Return Value

    Returns a MGLTransition struct containing the transition attributes.

MGLTransitionMake

The following functions are available globally.

  • MGLMapPointMake

    Creates a new MGLMapPoint from the given X and Y coordinates, and zoom level.

    Declaration

    Objective-C

    static inline MGLMapPoint MGLMapPointMake(CGFloat x, CGFloat y,
                                                        CGFloat zoomLevel)

    Swift

    func MGLMapPointMake(_ x: CGFloat, _ y: CGFloat, _ zoomLevel: CGFloat) -> MGLMapPoint
  • MGLMapPointForCoordinate

    Returns Mercator projection of a WGS84 coordinate at the specified zoom level.

    Declaration

    Objective-C

    extern MGLMapPoint MGLMapPointForCoordinate(CLLocationCoordinate2D coordinate,
                                                          double zoomLevel)

    Swift

    func MGLMapPointForCoordinate(_ coordinate: CLLocationCoordinate2D, _ zoomLevel: Double) -> MGLMapPoint
  • Converts a map zoom level to a camera altitude.

    Declaration

    Objective-C

    extern CLLocationDistance MGLAltitudeForZoomLevel(double zoomLevel,
                                                                CGFloat pitch,
                                                                CLLocationDegrees latitude,
                                                                CGSize size)

    Swift

    func MGLAltitudeForZoomLevel(_ zoomLevel: Double, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> CLLocationDistance

    Parameters

    zoomLevel

    The zoom level to convert.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    An altitude measured in meters.

  • MGLZoomLevelForAltitude

    Converts a camera altitude to a map zoom level.

    Declaration

    Objective-C

    extern double MGLZoomLevelForAltitude(CLLocationDistance altitude,
                                                    CGFloat pitch, CLLocationDegrees latitude,
                                                    CGSize size)

    Swift

    func MGLZoomLevelForAltitude(_ altitude: CLLocationDistance, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> Double

    Parameters

    altitude

    The altitude to convert, measured in meters.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    A zero-based zoom level.

  • MGLSphericalPositionMake

    Creates a new MGLSphericalPosition from the given radial, azimuthal, polar.

    Declaration

    Objective-C

    static inline MGLSphericalPosition
              MGLSphericalPositionMake(CGFloat radial, CLLocationDirection azimuthal,
                                       CLLocationDirection polar)

    Swift

    func MGLSphericalPositionMake(_ radial: CGFloat, _ azimuthal: CLLocationDirection, _ polar: CLLocationDirection) -> MGLSphericalPosition

    Parameters

    radial

    The radial coordinate.

    azimuthal

    The azimuthal angle.

    polar

    The polar angle.

    Return Value

    Returns a MGLSphericalPosition struct containing the position attributes.

  • MGLTransitionMake

    Creates a new MGLTransition from the given duration and delay.

    Declaration

    Objective-C

    static inline MGLTransition MGLTransitionMake(NSTimeInterval duration,
                                                            NSTimeInterval delay)

    Swift

    func MGLTransitionMake(_ duration: TimeInterval, _ delay: TimeInterval) -> MGLTransition

    Parameters

    duration

    The amount of time the animation should take, not including the delay.

    delay

    The amount of time in seconds to wait before beginning the animation.

    Return Value

    Returns a MGLTransition struct containing the transition attributes.

MGLZoomLevelForAltitude

The following functions are available globally.

  • MGLMapPointMake

    Creates a new MGLMapPoint from the given X and Y coordinates, and zoom level.

    Declaration

    Objective-C

    static inline MGLMapPoint MGLMapPointMake(CGFloat x, CGFloat y,
                                                        CGFloat zoomLevel)

    Swift

    func MGLMapPointMake(_ x: CGFloat, _ y: CGFloat, _ zoomLevel: CGFloat) -> MGLMapPoint
  • MGLMapPointForCoordinate

    Returns Mercator projection of a WGS84 coordinate at the specified zoom level.

    Declaration

    Objective-C

    extern MGLMapPoint MGLMapPointForCoordinate(CLLocationCoordinate2D coordinate,
                                                          double zoomLevel)

    Swift

    func MGLMapPointForCoordinate(_ coordinate: CLLocationCoordinate2D, _ zoomLevel: Double) -> MGLMapPoint
  • Converts a map zoom level to a camera altitude.

    Declaration

    Objective-C

    extern CLLocationDistance MGLAltitudeForZoomLevel(double zoomLevel,
                                                                CGFloat pitch,
                                                                CLLocationDegrees latitude,
                                                                CGSize size)

    Swift

    func MGLAltitudeForZoomLevel(_ zoomLevel: Double, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> CLLocationDistance

    Parameters

    zoomLevel

    The zoom level to convert.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    An altitude measured in meters.

  • MGLZoomLevelForAltitude

    Converts a camera altitude to a map zoom level.

    Declaration

    Objective-C

    extern double MGLZoomLevelForAltitude(CLLocationDistance altitude,
                                                    CGFloat pitch, CLLocationDegrees latitude,
                                                    CGSize size)

    Swift

    func MGLZoomLevelForAltitude(_ altitude: CLLocationDistance, _ pitch: CGFloat, _ latitude: CLLocationDegrees, _ size: CGSize) -> Double

    Parameters

    altitude

    The altitude to convert, measured in meters.

    pitch

    The camera pitch, measured in degrees.

    latitude

    The latitude of the point at the center of the viewport.

    size

    The size of the viewport.

    Return Value

    A zero-based zoom level.

  • MGLSphericalPositionMake

    Creates a new MGLSphericalPosition from the given radial, azimuthal, polar.

    Declaration

    Objective-C

    static inline MGLSphericalPosition
              MGLSphericalPositionMake(CGFloat radial, CLLocationDirection azimuthal,
                                       CLLocationDirection polar)

    Swift

    func MGLSphericalPositionMake(_ radial: CGFloat, _ azimuthal: CLLocationDirection, _ polar: CLLocationDirection) -> MGLSphericalPosition

    Parameters

    radial

    The radial coordinate.

    azimuthal

    The azimuthal angle.

    polar

    The polar angle.

    Return Value

    Returns a MGLSphericalPosition struct containing the position attributes.

  • MGLTransitionMake

    Creates a new MGLTransition from the given duration and delay.

    Declaration

    Objective-C

    static inline MGLTransition MGLTransitionMake(NSTimeInterval duration,
                                                            NSTimeInterval delay)

    Swift

    func MGLTransitionMake(_ duration: TimeInterval, _ delay: TimeInterval) -> MGLTransition

    Parameters

    duration

    The amount of time the animation should take, not including the delay.

    delay

    The amount of time in seconds to wait before beginning the animation.

    Return Value

    Returns a MGLTransition struct containing the transition attributes.